[BadgeUnstyled] Add useBadge hook #30246
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@material-ui/core: parsed: +0.15% , gzip: +0.11% |
mnajdova
commented
Dec 17, 2021
|
|
||
| export interface BadgeUnstyledComponentsPropsOverrides {} | ||
|
|
||
| export interface BadgeUnstyledTypeMap<P = {}, D extends React.ElementType = 'span'> { |
There was a problem hiding this comment.
These are moved to BadgeUnstyledProps.ts
mnajdova
commented
Dec 17, 2021
| @@ -258,7 +259,8 @@ async function generateProptypes( | |||
|
|
|||
| prop.filenames.forEach((filename) => { | |||
| const isExternal = filename !== tsFile; | |||
| const implementedByUnstyledVariant = filename === unstyledFile; | |||
| const implementedByUnstyledVariant = | |||
There was a problem hiding this comment.
Needed for extracting the default values from the BadgeUnstyledProps.ts file.
oliviertassinari
added
package: base-ui
michaldudak
reviewed
Dec 21, 2021
| @@ -42,36 +43,17 @@ const BadgeUnstyled = React.forwardRef(function BadgeUnstyled(props, ref) { | |||
| overlap: overlapProp = 'rectangular', | |||
There was a problem hiding this comment.
I'm wondering if it makes sense to include this prop as it's not used in the unstyled component.
There was a problem hiding this comment.
Good catch, looks like we can move it to the styled component’s props.
michaldudak
approved these changes
Dec 21, 2021
1 task
32 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE
BadgeUnstyleddoes no longer support theoverlapprop, it is now a prop only on theBadgecomponent inside@mui/material/Badge.As the prop is not available, some of the classnames have been renamed:
In order to avoid breaking changes in the
@mui/materialpackage, the old classes are added in addition to the new ones. Also theoverlapCircularandoverlapRectangularclasses keys are added, which can be used in combination with the new classes.The PR adds
useBadgehook, that is used insideBadgeUnstyled. It also updates thegeneratePropsscript to consider*Props.tsfiles when generating props.